User Template Update Endpoint

Overview

This endpoint allows users to update a specific template's details within a collection.

Request Details

HTTP Method

PATCH

Route

/api/users/[user_id]/collections/[collection_id]/templates/[template_id]

Route Parameters

Parameter	Type	Required	Description
user_id	integer	Yes	The ID of the authenticated user
collection_id	integer	Yes	The ID of the template collection
template_id	integer	Yes	The ID of the template

Headers

Header	Value	Required	Description
Accept	application/json	Yes	Specifies the response format
Content-Type	application/json	Yes	Request body format
Cookie	neptun-session	Yes	Session authentication cookie

Query Parameters

No query parameters required.

Request Body

Field	Type	Required	Description
description	string	No	New description of the template
file_name	string	No	New file name of the template

Response Format

Response Status Codes

Status Code	Description
200	Successfully updated template
400	Bad Request (invalid request body)
401	Unauthorized (invalid or missing session)
403	Forbidden (user_id mismatch)
404	Template not found
500	Server error

Success Response (200 OK)

{
  "template": {
    "id": 1,
    "description": "Updated Docker deployment script",
    "file_name": "docker-deploy-v2.sh",
    "created_at": "2024-01-01T12:00:00Z",
    "updated_at": "2024-01-01T12:30:00Z",
    "neptun_user_id": 1,
    "template_collection_id": 1,
    "user_file_id": 1
  }
}

Error Response (400 Bad Request)

{
  "statusCode": 400,
  "message": "Invalid template data"
}

TypeScript Interface

interface Template {
  id: number
  description?: string
  file_name: string
  created_at: string
  updated_at: string
  neptun_user_id: number
  template_collection_id?: number
  user_file_id?: number
  title?: string
  text: string
  language: string
  extension: string
}

interface UpdateTemplateRequest {
  description?: string
  file_name?: string
  file?: {
    title?: string
    text?: string
    language?: string
    extension?: string
  }
}

interface ApiResponse {
  template: Template
}

Python Model

from datetime import datetime
from typing import Optional
from pydantic import BaseModel

class UpdateFileData(BaseModel):
    title: Optional[str]
    text: Optional[str]
    language: Optional[str]
    extension: Optional[str]

class UpdateTemplateRequest(BaseModel):
    description: Optional[str]
    file_name: Optional[str]
    file: Optional[UpdateFileData]

class Template(BaseModel):
    id: int
    description: Optional[str]
    file_name: str
    created_at: datetime
    updated_at: datetime
    neptun_user_id: int
    template_collection_id: Optional[int]
    user_file_id: Optional[int]
    title: Optional[str]
    text: str
    language: str
    extension: str

class ApiResponse(BaseModel):
    template: Template

Code Examples

cURL Example

curl -X PATCH "https://neptun-webui.vercel.app/api/users/1/collections/1/templates/1" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -H "Cookie: neptun-session=your-session-cookie" \
  -d '{
    "description": "Updated Docker deployment script",
    "file_name": "docker-deploy-v2.sh"
  }'

Python Example

import httpx
from typing import Optional

async def update_template(
    user_id: int,
    collection_id: int,
    template_id: int,
    description: Optional[str] = None,
    file_name: Optional[str] = None,
    session_cookie: str = None
) -> ApiResponse:
    url = f"https://neptun-webui.vercel.app/api/users/{user_id}/collections/{collection_id}/templates/{template_id}"

    data = {}
    if description is not None:
        data["description"] = description
    if file_name is not None:
        data["file_name"] = file_name

    async with httpx.AsyncClient() as client:
        response = await client.patch(
            url,
            json=data,
            headers={
                "Accept": "application/json",
                "Content-Type": "application/json",
                "Cookie": f"neptun-session={session_cookie}"
            }
        )
        response.raise_for_status()
        return ApiResponse(**response.json())

TypeScript/JavaScript Example

async function updateTemplate(
  userId: number,
  collectionId: number,
  templateId: number,
  data: UpdateTemplateRequest,
  sessionCookie: string
): Promise<ApiResponse> {
  const response = await fetch(
    `https://neptun-webui.vercel.app/api/users/${userId}/collections/${collectionId}/templates/${templateId}`,
    {
      method: 'PATCH',
      headers: {
        'Accept': 'application/json',
        'Content-Type': 'application/json',
        'Cookie': `neptun-session=${sessionCookie}`,
      },
      body: JSON.stringify(data),
    }
  )

  if (!response.ok) {
    throw new Error(`HTTP error! status: ${response.status}`)
  }

  return await response.json()
}

Notes

• The session cookie is required for authentication
• At least one of description or file_name must be provided
• The template must belong to the specified collection
• The collection must belong to the specified user